vFire has two Application Programming Interfaces (or APIs), which enable you to develop programs that automate many common vFire transactions. This section of the documentation deals with the Classic API. For more information on the RESTful Alemba API, introduced in 9.7, see here.
The API Cost Center transactions can be used to create, update, delete and retrieve cost center entities in the CMDB.
CostCenterCreate Transaction
The CostCenterCreate transaction can be used to create a new cost center record and save its details.
Input Parameters: CostCenterCreateRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Ignored |
- |
Ignored on create |
|
sGroupName |
String |
No |
- |
Cost Center name |
|
sDescription |
String |
No |
“” |
Cost Center Description |
|
lCategory |
Lookup Field |
No |
0 |
Cost Center Category |
|
lParentCostCenter |
Lookup Field |
No |
0 |
Parent Cost Center |
|
lPartition |
Lookup Field |
No |
Analyst’s default partition |
Partition in which to create this cost center |
|
sReason |
String |
No |
“” |
Audit reason |
|
aCustomParameters |
Array |
No |
“” |
Return Values: CostCenterResponse
|
Argument |
Type |
Description |
|---|---|---|
|
nEntityRef |
Integer |
Newly created cost center ref |
|
String |
Error/Warning message returned from API |
|
|
Ret |
Error/Warning number returned from API |
CostCenterUpdate Transaction
The CostCenterUpdate transaction can be used to update the details of an existing cost center record.
Input Parameters: CostCenterUpdateRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the cost center to update |
|
sGroupName |
String |
No |
(As is) |
Cost Center name |
|
sDescription |
String |
No |
(As is) |
Cost Center Description |
|
lCategory |
Lookup Field |
No |
(As is) |
Cost Center Category |
|
lParentCostCenter |
Lookup Field |
No |
(As is) |
Parent Cost Center |
|
lPartition |
Lookup Field |
No |
(As is) |
Partition in which to create this cost center |
|
sReason |
String |
No |
“” |
Audit reason |
|
aCustomParameters |
Array |
No |
“” |
Return Values: CostCenterResponse
See CostCenterResponse for more information.
CostCenterRetrieve Transaction
The CostCenterRetrieve transaction can be used to retrieve the details of a cost center record.
Input Parameters: CostCenterEntityRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the cost center to retrieve |
|
aCustomParameters |
Array |
No |
“” |
Return Values: CostCenterRetrieveResponse
|
Argument |
Type |
Description |
|---|---|---|
|
Ret |
Error/Warning number returned from by API |
|
|
String |
Error/Warning message returned by the API |
|
|
ResultSet |
DataSet |
CostCenterDelete Transaction
The CostCenterDelete transaction can be used to find and delete a cost center record. After the transaction is executed, the status and audit trail are updated.
Input Parameters: CostCentreDeleteRequest
|
Argument |
Type |
Mandatory |
Default |
Description |
|---|---|---|---|---|
|
sID |
String |
No. See Transaction Login. |
“” |
Analyst’s current Session ID |
|
sLoginUserID |
String |
No. See Transaction Login. |
“” |
Analyst’s Login ID |
|
sLoginPassword |
String |
No. See Transaction Login. |
“” |
Analyst’s Password |
|
sDatabase |
String |
No. See Transaction Login. |
“” |
Name of the vFire system for logging in. |
|
lEntityRef |
Lookup Field |
Yes |
- |
Reference number of the cost center to delete |
|
sReason |
String |
No |
“” |
Audit reason |
|
aCustomParameters |
Array |
No |
“” |
Return Values: CostCentreResponse
See CostCenterResponse for more information.